[[PageOutline(3-4, Sections)]]

== !GetSubLanguages == 

=== Intro ===

  get list of supported subtitle languages


----
=== Description ===

  '''struct !GetSubLanguages(string $language = 'en')'''
  
  Returns list of supported subtitle languages.


----
=== Parameters ===

  ''language''::
    * ISO639-1 2-letter language code of user's interface language.
    * language names (''!LanguageName'') will be returned in this language
    * default is ''en'' (english)     


----
=== Return Values ===

  Output is returned in this structure:
   
{{{
struct(
  array(
    struct(
      (string) [SubLanguageID],
      (string) [LanguageName],
      (string) [ISO639]
    ) [lang]
  ) [data],
  (double) [seconds]
)
}}}

  and contains these elements:
    ''data''::
       array of enabled subtitle languages 
         * ''SubLanguageID'': ISO639-2 3-letter language code
         * ''!LanguageName'': language name in language specified by parameter ''language''
         * ''ISO639''       : ISO639-1 2-letter language code
    ''seconds''::
      time taken to execute this command on server


----
=== Implementations ===

  There are currently no available sample implementations.


----
=== Changelog ===

  Version 1: created this function


----
=== Examples ===


==== Input ====
  
{{{
#!xml
<methodCall>
 <methodName>GetSubLanguages</methodName>
 <params>
  <param>
   <value><string>en</string></value>
  </param>
 </params>
</methodCall>
}}}

  
==== Output ====

{{{
#!xml
<methodResponse>
 <params>
  <param>
   <value>
    <struct>
     <member>
      <name>data</name>
      <value>
       <array>
        <data>
         <value>
          <struct>
           <member>
            <name>SubLanguageID</name>
            <value><string>eng</string></value>
           </member>
           <member>
            <name>LanguageName</name>
            <value><string>English</string></value>
           </member>
           <member>
            <name>ISO639</name>
            <value><string>en</string></value>
           </member>
          </struct>
         </value>
         
         ... more language information structures go here (if any) ...
         
        </data>
       </array>
      </value>
     </member>
     <member>
      <name>seconds</name>
      <value><double>0.024</double></value>
     </member>
    </struct>
   </value>
  </param>
 </params>
</methodResponse>
}}}


----
=== Notes ===

  * see [http://www.loc.gov/standards/iso639-2/php/code_list.php ISO639-1] 2-letter language codes


----
=== See also ===


----
=== Comments ===

	add your comments, hints and suggestions here if you like ...


--------
[Prev] [wiki:XmlRpcIntro Home] [Next]